## Start Mining

1. **Pick a coin**: whatever the dropdown offers is what is supported.
2. **Pick a pool**: HeroMiners, Kryptex, LuckyPool, PEARLSKI, PearlFortune, PearlHash, F2Pool. Choose the pool first - the client then hides the miners that pool cannot use.
3. **Enter wallet / username**: follow that pool's rule. Kryptex takes either; F2Pool only takes its account name (top right of the F2Pool dashboard), not a wallet address; the others take a wallet.
4. **Pick a miner**: defaults to "Auto (system recommended)", which uses the version we recommend (new versions are first offered for manual selection and only become the recommendation once proven stable); to use the newest version or keep a specific one, pick it in the "Kernel version" dropdown. It downloads on first use and verifies itself - you never place files by hand.
5. **Connection**: Direct TCP is the default. Direct TLS is offered only for pools with compatible TLS nodes. Nodes are filtered by the selected TCP/TLS transport. “Automatic selection” chooses usable official and custom nodes of the current coin and pool; you may also choose a preferred node manually. Recovery preserves that choice and shows the actual node separately.
6. **Your proxy (Direct TCP/TLS only)**: start your proxy software, then enter its actual local port, e.g. `http://127.0.0.1:7897` or `socks5://127.0.0.1:1080`. Use your software’s actual port, never a subscription URL.
7. **Relay**: keeps the node field in place, disabled, and ignores the proxy above. An available backup connection may be used after connection failures.
8. **Custom miner (optional)**: only WildRig, PeakMiner, OneZeroMiner and SRBMiner are supported. Select its family and main EXE (`wildrig.exe`, `peakminer.exe`, `onezerominer.exe` or `SRBMiner-MULTI.exe`) from the fully extracted folder. Vminer validates the miner identity; run a compatibility test after importing. A renamed EXE is fine if its contents match the selected miner.
9. **Press Start.**

- **GPUs**: `all` uses every card, or enter `0` / `0,1,2`.
- **Worker name**: set a prefix, or use the random-suffix button; left blank it follows the machine name.

> Stop ends the miner and clears state.


## Connection modes and your proxy

Saved connection choices are preserved. Upgrades from versions without mode selection initially use Relay.

- **Connection**: Direct TCP is the default. Direct TLS is offered only for pools with compatible TLS nodes. Nodes are filtered by the selected TCP/TLS transport. “Automatic selection” chooses usable official and custom nodes of the current coin and pool; you may also choose a preferred node manually. Recovery preserves that choice and shows the actual node separately.
- **Your proxy (Direct TCP/TLS only)**: start your proxy software, then enter its actual local port, e.g. `http://127.0.0.1:7897` or `socks5://127.0.0.1:1080`. Use your software’s actual port, never a subscription URL.
- **Relay**: keeps the node field in place, disabled, and ignores the proxy above. An available backup connection may be used after connection failures.

**Network recovery**: temporary loss of connectivity, connection timeouts or resets keep retrying automatically with increasing, bounded delays; two retries do not stop mining. A running mining process reconnects itself; only an exited process or a temporarily failed startup is restarted. Direct mode keeps the selected node and explicit proxy, without switching to Relay or another pool. Relay may use an available backup connection after repeated failures. Stop, Netbar yielding, scheduled breaks, exit and version updates cancel pending recovery. GPU faults, permanent login rejection, missing files and invalid parameters retain fault-stop protection and are not restarted forever. Initial verification is still required; a temporary heartbeat or verification-service outage does not interrupt existing mining.

Valid downloaded and imported miner versions are kept in the client folder and reused after client updates; selected versions must still meet current compatibility requirements. Custom import copies the complete folder into downloads and no longer needs the original folder after success. Keep downloads and any legacy custom-kernels folder. If space is low, make room on the disk and retry; an update that cannot preserve the files leaves the previous installation in place.

## Custom miner versions

Only WildRig, PeakMiner, OneZeroMiner and SRBMiner are supported. Download and fully extract the version into any folder. Select its type under Mining software, click Custom, then select wildrig.exe, peakminer.exe, onezerominer.exe or SRBMiner-MULTI.exe. Keep the complete folder and dependencies; Vminer copies the folder automatically. It checks the miner identity and refuses mismatched or unidentified programs. Run a compatibility test after importing. Uncheck Use imported version to return to the official version. A renamed EXE is fine if its contents match the selected miner.

## What the Home Page Shows

- Total hashrate, shares, pool balance, paid, coin price; per-card hashrate, temperature and power.
- **Floating window**: turn on "Open overlay" at the top of the window for a small desktop window with hashrate, shares, temperature and power.
- **Pool site**: opens that pool's lookup page with the wallet you already entered.
- **Related sites**: pool homepages, block explorers and other entry points.
- If the price feed or a pool API is briefly down those figures show N/A and keep retrying. Mining is unaffected.

> Pool credit is authoritative. The client shows this machine's view, which differs because of dynamic difficulty, reporting windows, rejected/stale shares and reporting delay.

## Stats & Fleet

We recommend registering and signing in to Fleet: while you are not signed in, the top-right button is a gold "Register / sign in to Fleet".

Register an account (username + password + email); signing in claims this machine under it. Sign in to the web console with the same account to see every machine you own.

In normal mode, Fleet Control sign-in applies only to this device. When preparing a netbar master image, enable netbar mode before signing in. In netbar mode, the sign-in is copied with the Vminer folder to the other rigs. A change to netbar mode takes effect for Fleet Control at the next sign-in. Signing out in the client affects only this device. To revoke a shared sign-in, manage sessions in the Fleet Control web console.

For a new café or new seats on the updated version, enable Internet café mode and sign in to Fleet Control on the master image before syncing the Vminer folder. Start two seats first. While they are idle, check that both appear separately and verify their command results. To stop this image from adding more seats, choose “Stop adding café devices” in your Fleet Control account’s signed-in devices list. Registered seats stay connected.

- **See**: online state, hashrate, shares, temperature, power, GPU model.
- **Control**: start/stop mining, restart the miner, switch coin / pool / miner / wallet, change power, fan and clocks, rename, reboot, shut down.
- A machine belongs to one account only; commands are queued and run when the machine is online.
- The web console also shows earnings; the bell at the top right gets a red dot when there's a new notice.
- **Shutdown works remotely, power-on does not** - someone has to press the button.

> Email is the only way to recover a password, so register with one you can read.

**Change configuration**: from a rig’s action list, or after selecting a batch, click “Change configuration…”. When full configuration is supported, set the worker name, coin, pool, miner and version, connection method, direct node and payout wallet or username together. A single rig, including a batch with one selection, shows its current settings. A batch shows shared values or “Multiple values”; expand the details to inspect each rig. Only edited fields are sent. In the full form, editing the name sets the complete fixed worker name and disables the previous prefix or random suffix. Leaving it unchanged preserves the existing naming rules.

Changing coin or pool preserves compatible saved or manually selected miners and valid versions. Only a missing or incompatible choice receives a legal default: PeakMiner → SRBMiner → OZM (onezerominer). The dropdown follows that order; other legal choices keep their order. Pools supporting only WildRig use WildRig. The version returns to the system recommendation only when the miner changes or the version is invalid. Automatic selection remains automatic, with an effective miner compatible with the final pool. Only supported miner/version combinations are selectable; explicitly invalid combinations are not sent. “Auto (system recommended version)” does not mean latest. In Relay mode the node field stays in place, disabled. Returning to Direct on the same pool preserves node memory; changing pools replaces an invalid node with a valid default choice. Local user-proxy settings are preserved. An identity invalid for the destination pool turns the wallet/username field red and disables Apply until corrected.

The wallet or username shows only a verified current value; a value not yet synchronized is clearly marked, never guessed. An unedited field is omitted. Explicitly entering a replacement requires checking the payout destination. When switching to or from F2Pool, enter the destination pool’s username or wallet rather than assuming the previous identity applies. The client validates the final combination before saving. An idle rig only saves, without starting mining; a running rig switches at most once.

Every rig and batch uses “Change configuration…”. Clients supporting full configuration show the complete form; otherwise choose one item in the same window. To change several together, download the latest full package from the official website. In mixed batches the full form sends only to supported rigs; “Change one item…” handles the remaining targets. Single-item actions retain the client’s existing naming and identity rules and never automatically chain wallet changes with pool or coin changes. Cancel sends nothing. Queued is not executed: check receipts and subsequent state.

**Automatic Direct nodes and recovery**: choose “Automatic selection” (the empty option) to select a usable low-latency route from official and saved custom nodes for the current coin and pool. A manually chosen node remains the saved preference; recovery may use another node of the same pool without changing that preference. Official updates do not remove custom nodes. If every node is unavailable, retries continue with backoff and reconnect automatically when a route returns; probe fluctuations alone do not restart a healthy connection. The interface separates the active node, connection/pool-data/user-share status and recent switch reason. A reachable probe does not prove mining or shares have resumed. Relay keeps the node field in place, disabled; your own proxy applies only to Direct. Manual stop, Netbar yielding and rest take priority over recovery. Fleet automatic-node commands use the client’s supported automatic behavior; clients without the new capability retain existing operations. Up to 64 valid custom candidates are supported per coin and pool, with a 32 KiB transfer limit; the complete launch command also has a Windows safety limit. Adding or starting beyond a limit shows a clear message without changing saved data. Remove unused nodes or shorten long settings first.

**LAN downloads and staged updates**: LAN coordination, peer discovery and validation of received files run automatically, but LAN file distribution does not itself trigger an upgrade. Installation still follows the update setting or a manual command. Fleet “Staged update” schedules predownloads, then offers “Install together once all are downloaded” or “Install each as soon as it’s downloaded”; task progress and stopping further installations are available. Netbar clients do not update automatically: update the master image manually, then distribute it through the diskless system. If LAN coordination is temporarily unavailable, peer discovery still tries broadcasts and can fall back to server download. Netbar clients share on the local network by default. Downloads wait for available LAN peers first. Each machine shares verified files with one peer at a time. Server download is used when no peer is available or the wait expires. Keep Vminer running and allow local network traffic through the firewall. Sharing runs in the background and respects Netbar yielding and manual stop.

## Netbar Mode

Mine while the PC is idle and step aside the moment a customer uses it.

> **Remember to register and sign in to Fleet**: click "Register / sign in to Fleet" at the top right. Enable netbar mode on the master machine, then sign in once and every cloned PC is listed under your account - see the whole cafe and start/stop it from your phone. **Manual mode is woken from Fleet, so signing in is required.**

- **Full power**: always mining, for dedicated rigs.
- **Avoid (default)**: Checks the entire PC for processes on the avoid list, including those running in the background. Mining resumes after those processes have closed and the PC has been clear for 1 minute.
- **Sensitive**: Yields on keyboard or mouse activity, or when another app exceeds 20% GPU 3D usage in two consecutive checks. Mining resumes after neither trigger has been present for 2 minutes.
- **Manual**: boots hidden and does not mine until woken from the web console or started locally; once mining it no longer yields, until shutdown or a manual stop.
- **Administrator required**: Right-click Vminer and select “Run as administrator”.
- **Power and overclocking**: Set power, fans, core and memory offsets, and clock locks on the OC page. When yielding, Vminer restores the hardware defaults for any settings it attempted to apply, even if OC is now off. Settings Vminer did not touch are left alone. If restoration fails, Vminer keeps retrying and mining stays paused until it succeeds. Saved values are kept, and applicable settings are reapplied when mining resumes.

> Diskless cafes: set one machine up, copy the whole Vminer folder into the master image, and every PC starts with the same configuration.

## Power, Fan and Overclocking

On the "OC" page. The master switch "Enable OC" covers power, fan and core/memory clocks; turned off the client touches nothing and whatever the driver or third-party tools set stays as is.

On the OC page, the master switch controls power, fans and core and memory clocks. Turning it off prevents new OC settings from being applied. Settings previously applied by Vminer can still be restored to defaults.
- **Fan**: fixed speed or leave it to the driver.
- **Core / memory, four settings**: core clock (mining default + N, e.g. "base+50"), core offset (shifts the factory clock up or down), memory clock (locks one step such as 810 - start mining and check the status column that it locked; it will not lock reliably while a monitor is plugged into that card - use integrated graphics and restart the PC) and memory offset. Off by default, advanced, applied only while mining. Every change gets a 10-minute trial; a dropped card, driver reset, zero hashrate or overheating rolls it back automatically.

> Turning on "Enable OC" needs Vminer to run as administrator.

## System Settings

Each card's description is in the "?" next to its title - hover to show it.

- **Automatic seamless updates**: a downloaded and verified update restarts Vminer by itself.
- **Auto restart on failure**: when mining hits a fault that restarting the miner cannot fix, Vminer restarts itself (mining background program not responding) or the PC (GPU driver crash or hung GPU), and mining resumes; there is a 60-second window to cancel a PC restart. Faults a restart cannot fix (unsupported GPU, not enough virtual memory) do not trigger a restart; mining stops and the reason is shown.
- **Take a 5-minute break**: after 24 or 48 hours of continuous mining, pause for 5 minutes, then resume by itself.
- **Scheduled mining**: start and stop at set times every day using this PC's clock, 24-hour, hour and minute in separate boxes. Leave Stop as "-" to keep mining after the start time. A manual stop during the scheduled hours is respected until the next day's start time. Not available while Netbar Mode is on.
- **One-click allow Vminer**: use it when antivirus deletes the miner.

## Downloads & Updates

- The installer ships without miner binaries - a miner downloads the first time you select it, which keeps it small.
- Downloads use a primary and a backup route, switch automatically on failure, and verify size and hash.
- Automatic client updates are on by default outside Netbar mode. Netbar mode does not support automatic client updates; miner downloads remain independent and are not affected by this restriction.

## Notes

- If antivirus deletes the miner, use "One-click allow Vminer" in System Settings to allowlist the folder; 360, Huorong and similar need their own entry as well.
- Logs show only what concerns you: local service, miner download, pool connection, share results and faults. Minor local hiccups are not flagged in red.
- If the heartbeat to our servers is briefly unreachable you get a "mining continues, reconnecting" notice - one failed heartbeat never stops mining.
- Make sure the machine suits sustained full load; watch power draw, temperature and the power supply.
- Earnings, pool stability and third-party network services are controlled by their providers.


## Custom pool nodes

Direct TCP lists TCP nodes only. Direct TLS is offered only when the pool publishes compatible TLS nodes, and lists TLS nodes only. Both direct modes support custom nodes and your own proxy. Select a pool and click Add beside Node; enter a pool node or your own relay for that same pool using its domain/IP and port. TLS certificates must validate. For an IP, optionally enter the certificate name; leaving it empty requires a valid IP certificate. Add and select saves the node; only custom entries can be deleted. Automatic selection probes nodes of the same pool and transport. If all are unavailable, retries continue and mining resumes when a route returns, without silently changing TCP/TLS. A log message confirms an actual switch from a custom node to a backup pool node; a successful probe alone does not prove mining has resumed. Relay mode keeps the node field in place, disabled, and ignores your proxy setting. Manual stop, Netbar yielding and rest always take priority; stop mining before editing nodes.


## Background update checks

Vminer checks for miner and component updates in the background. If a check fails, mining continues with the current version and the check is retried later. Download progress appears only when files are being downloaded. Official updates do not overwrite imported custom miners.


Automatic updates are unavailable while Netbar mode is enabled. Update the client version in the master disk image manually; alternatively, find the master disk's fixed worker name in the fleet console and click Manual update.

<!-- update-cache-guide:begin -->

Downloaded installation packages are kept. After Vminer restarts, it checks the current update information before reusing a package, then follows your update setting or manual action to install it. If the network is temporarily unavailable, the current version keeps running.

<!-- update-cache-guide:end -->

## Rig ownership and wallet-wide earnings

Rig lists, online counts, hashrate and shares follow current ownership. Earnings query only explicitly linked account wallets: one payout wallet per coin. Settings reject duplicate addresses. The default wallet still prefills configuration. Totals include wallet history and contributions from other rigs; they are not the exclusive earnings of owned rigs. Rigs using another wallet show “Unlinked wallet; excluded from earnings” but remain in owned-rig and hashrate totals. Missing wallet information is marked as awaiting confirmation. F2Pool requires its corresponding read-only account link. Adding or removing a wallet, or transferring ownership, never automatically changes mining wallets.

## Avoid-list names

Built-in entries show an English abbreviation followed by the name in your selected language, such as LOL/League of Legends. After changing the client language, reopen the list. Search by abbreviation, translated name or process name. Missing translations fall back to English; identical names are not repeated. Checked rules stay the same, and your custom names and programs are preserved.

Account → Payout wallets can also link one Kryptex mining username beginning with krx. This is only a configuration choice, excluded from earnings statistics; it never changes rigs automatically. In Change configuration, use the arrow beside the wallet field to select a linked identity or type one manually: Kryptex accepts the current coin’s wallet or a K mining username; F2Pool accepts only a pool username, which you can type or select from your saved entries; other pools accept the current coin’s wallets only. A batch lists only identities valid for every target. Click Apply and confirm to send changes. Set the mining username and the read-only earnings link separately under Account Management → Payout wallets → F2Pool.

A rig belongs to one account. An unclaimed rig can join after signing in on the client. If it belongs to another account, ask its current owner to transfer it from Fleet first, then sign in to the receiving account. Signing in to a different account alone does not transfer ownership, change the mining wallet or stop mining.

## Cloud OC settings

On the Fleet OC page, use “Edit and save…” to set values per GPU. Settings are saved per device and survive a rename. Use the checkbox on the main panel to turn cloud OC on or off, then confirm once. Supported clients that are mining restart the miner once to switch. Paused café devices switch when mining resumes. Other devices that cannot switch now do so at the next mining start. While mining, the checkbox reflects the client’s report.

If the rig is mining with cloud OC, saving offers to restart the miner once and apply the new settings. Choose No to save without restarting. With cloud OC enabled, the client loads the saved values the next time mining starts. Both normal and café modes are supported. Run as administrator and enable local OC and manual power and fan control. Clock changes also require the advanced switch. Open Clock offsets (advanced) in the device’s Fleet panel or on the PC. If cloud OC is already active, this only saves the switch. Cloud clock settings apply the next time the miner starts.

On stop or exit, power, fan, core/memory offsets and clock locks written by this feature return to defaults; saved local settings are retained. An unfinished reset keeps its recovery record and retries, without layering new cloud settings. If cloud settings cannot be fetched, mining continues. Check the reported application status: saved does not mean applied. A new owner does not inherit the previous owner’s cloud settings.

<!-- connection-recovery-guide:begin -->

## Automatic connection recovery and notices

If Relay mode loses its connection, Vminer tries to reconnect. It keeps retrying while the connection is unavailable and keeps the working connection once service returns. Manual stops, internet café pauses and scheduled breaks take priority.

Recovery keeps the current pool and leaves your saved connection settings as they are.

In Fleet, open My account → Connection recovery notices, enable notices, link Telegram and verify your email. The first complete failure and later recovery generate results; repeated retries do not repeat notices. Notification delays or failures do not block reconnection. Unlinked channels receive nothing. Automatic recovery must be permitted by the server.

Upgrading keeps your account and device ownership. Existing controls require no new claim. For new controls, check which options are currently available. If an action shows “Result unconfirmed”, check the rig’s actual state before retrying. Unconfirmed actions are never repeated automatically.

The account page shows verified devices. On a device needing verification, open Fleet, select Verify this device and enter the current account password. Ownership stays unchanged; no new claim is needed. Saving is not confirmation of application. Existing Fleet control remains available.

<!-- connection-recovery-guide:end -->

<!-- account-allocation-guide:begin -->

## Sub-account hashrate transfer

In Fleet, open My account → Sub-account hashrate transfer to set one recipient at 0–15%. It applies only to compatible miners currently owned by this account. Set 0% or turn it off to disable allocation. Unsupported clients or pool combinations do not apply allocation; normal mining continues. Hashrate transfers only when enabled and the rate is above 0%.

Enter the recipient’s payout wallet for each coin; existing bindings are offered as suggestions. These settings are saved separately, do not use this account’s earnings-wallet slots, and do not change the wallet bindings used for its earnings summary. Coins left blank receive no allocation. A supplied Kryptex mining username takes priority over the wallet. F2Pool uses a username: enter the recipient’s F2Pool username for payouts to that account; leaving it blank uses the default payout configuration. No allocation occurs when the recipient matches this miner’s actual payout wallet or pool username.

Saving or removing requires your account password again. Check the name, percentage and every payout identity before confirming. Saved does not mean applied: check the device’s actual state. Temporary network failures do not stop normal mining. A previous owner’s allocation settings no longer apply after ownership changes.

<!-- account-allocation-guide:end -->
